home *** CD-ROM | disk | FTP | other *** search
/ Amiga Games: Greatest Hits 1996 / Amiga Games: Greatest Hits 1996.iso / userbox / publicdomain / identify / identify.doc < prev    next >
Text File  |  1996-07-21  |  7KB  |  197 lines
  1. TABLE OF CONTENTS
  2.  
  3. identify.library/IdAlert
  4. identify.library/IdExpansion
  5. identify.library/IdHardware
  6.  
  7. identify.library/IdAlert                              identify.library/IdAlert
  8.  
  9.    NAME
  10.         IdAlert - get description of an alert (V3)
  11.  
  12.    SYNOPSIS
  13.         Error = IdAlert(Code,TagList)
  14.         D0.l            D0.l   A0.l
  15.  
  16.         LONG IdAlert(ULONG, struct TagItem *);
  17.  
  18.         Error = IdAlertTags(Code,Tag1,...)
  19.  
  20.         LONG IdAlertTags(ULONG, ULONG,...);
  21.  
  22.    FUNCTION
  23.         Get a human readable description of the alert ('Guru') code.
  24.  
  25.    INPUTS
  26.         Code          -- (ULONG) alert code, as defined in exec/alerts.h
  27.  
  28.         TagList       -- (struct TagItem *) tags that describe further
  29.                          options:
  30.  
  31.                 IDTAG_DeadStr   -- (STRPTR) Alert type string (deadend
  32.                         or recoverable). You may skip this tag if you
  33.                         do not want to get the string.
  34.                 IDTAG_SubsysStr -- (STRPTR) String of the subsystem
  35.                         that caused the alert (CPU, exec.library, ...).
  36.                         You may skip this tag if you do not want to
  37.                         get the string.
  38.                 IDTAG_GeneralStr -- (STRPTR) General alert cause. You
  39.                         may skip this tag if you do not want to get
  40.                         the string.
  41.                 IDTAG_SpecStr   -- (STRPTR) Specified alert cause. You
  42.                         may skip this tag if you do not want to get
  43.                         the string.
  44.                 IDTAG_StrLength -- (UWORD) Maximum length of the
  45.                         string buffer, including termination. Defaults
  46.                         to 50.
  47.  
  48.    RESULT
  49.         Error         -- (LONG) error code, or 0 if everything went fine.
  50.  
  51.    NOTE
  52.         This call is guaranteed to preserve all registers except D0.
  53.  
  54.    BUGS
  55.  
  56.    SEE ALSO
  57.  
  58. identify.library/IdExpansion                      identify.library/IdExpansion
  59.  
  60.    NAME
  61.         IdExpansion - get name of expansion board (V3)
  62.  
  63.    SYNOPSIS
  64.         Error = IdExpansion(TagList)
  65.         D0.l                  A0.l
  66.  
  67.         LONG IdExpansion(struct TagItem *);
  68.  
  69.         Error = IdExpansionTags(Tag1,...)
  70.  
  71.         LONG IdExpansionTags(ULONG,...);
  72.  
  73.    FUNCTION
  74.         Gets the name and class of the expansion and it's manufacturer.
  75.  
  76.    INPUTS
  77.         TagList       -- (struct TagItem *) tags that describe further
  78.                          options:
  79.  
  80.                 IDTAG_ConfigDev -- (struct ConfigDev *) ConfigDev
  81.                         structure containing all information. You
  82.                         should use this tag if ever possible, since
  83.                         there are more possibilities to recognize and
  84.                         distinguish between a board.
  85.                 IDTAG_ManufID   -- (UWORD) Manufacturer ID if ConfigDev
  86.                         is not provided. You also have to provide
  87.                         IDTAG_ProdID!
  88.                 IDTAG_ProdID    -- (UBYTE) Product ID if ConfigDev
  89.                         is not provided. You also have to provide
  90.                         IDTAG_ManufID!
  91.                 IDTAG_ManufStr  -- (STRPTR) Pointer to a buffer space
  92.                         for the manufacturer name. You may skip this
  93.                         tag if you do not want to get this string.
  94.                 IDTAG_ProdStr   -- (STRPTR) Pointer to a buffer space
  95.                         for the product name. You may skip this tag if
  96.                         you do not want to get this string.
  97.                 IDTAG_ClassStr  -- (STRPTR) Pointer to a buffer space
  98.                         for the product class. You may skip this tag if
  99.                         you do not want to get this string.
  100.                 IDTAG_StrLength -- (UWORD) Buffer length, including
  101.                         termination. Defaults to 50.
  102.  
  103.    RESULT
  104.         Error         -- (LONG) error code, or 0 if everything went fine.
  105.  
  106.    NOTE
  107.         If the manufacturer or the product is not known, the string will be
  108.         filled with its number.
  109.  
  110.         This call is guaranteed to preserve all registers except D0.
  111.  
  112.    BUGS
  113.         There are by far not all existing boards implemented. Please send
  114.         the manufacturer id and name and the products id, name and class
  115.         of all unknown boards to me. My E-Mail: "rkoerber@tfh.dssd.sub.org".
  116.  
  117.    SEE ALSO
  118.  
  119. identify.library/IdHardware                        identify.library/IdHardware
  120.    NAME
  121.         IdHardware - get information about the system (V3)
  122.  
  123.    SYNOPSIS
  124.         String = IdHardware(Type,TagList)
  125.          D0.l               D0.l   A0.l
  126.  
  127.         STRPTR IdHardware(ULONG, struct TagItem *);
  128.  
  129.         String = IdHardwareTags(Type,Tag1,...)
  130.  
  131.         STRPTR IdHardwareTags(ULONG, ULONG,...);
  132.  
  133.    FUNCTION
  134.         Gets information about the current system environment. This function
  135.         is fully DraCo compatible!
  136.  
  137.    INPUTS
  138.         Type          -- (ULONG) Information type. These types are known
  139.                          in V3:
  140.  
  141.                 IDHW_SYSTEM     -- What system is used?
  142.                         (e. g. "Amiga 4000")
  143.  
  144.                 IDHW_CPU        -- What kind of CPU is available?
  145.                         (e. g. "68060")
  146.  
  147.                 IDHW_FPU        -- What kind of FPU is available?
  148.                         (e. g. "68060")
  149.  
  150.                 IDHW_MMU        -- What kind of MMU is available?
  151.                         (e. g. "68060")
  152.  
  153.                 IDHW_OSVER      -- What OS version is used?
  154.                         (e.g. "V39.106")
  155.  
  156.                 IDHW_EXECVER    -- What exec version is used?
  157.                         (e.g. "V39.47")
  158.  
  159.                 IDHW_WBVER      -- What WorkBench version is used?
  160.                         (e.g. "V39.29")
  161.  
  162.                 IDHW_ROMSIZE    -- Size of AmigaOS ROM
  163.                         (e.g. "512KB")
  164.  
  165.                 IDHW_CHIPSET    -- What Chipset is available?
  166.                         (e.g. "AGA")
  167.  
  168.                 IDHW_GFXSYS     -- What Graphic Board System is used?
  169.                         (e.g. "CyberGraphX")
  170.  
  171.                 IDHW_CHIPRAM    -- Size of complete Chip RAM
  172.                         (e.g. "2MB")
  173.  
  174.                 IDHW_FASTRAM    -- Size of complete Fast RAM
  175.                         (e.g. "12MB")
  176.  
  177.                 IDHW_RAM        -- Size of complete System RAM
  178.                         (e.g. "14MB")
  179.  
  180.         TagList       -- (struct TagItem *) tags that describe further
  181.                          options. Currently, there are none. You may
  182.                          provide NULL.
  183.  
  184.    RESULT
  185.         String        -- (STRPTR) String containing the desired
  186.                 information, or NULL if not available. Note that
  187.                 all strings are READ ONLY!
  188.  
  189.    NOTE
  190.         This call is guaranteed to preserve all registers except D0.
  191.  
  192.    BUGS
  193.  
  194.    SEE ALSO
  195.  
  196.  
  197.